Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(mgmt): update metrics endpoints to serve new dashboard design #435

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Aug 22, 2024

Because

  • Pipeline and credit endpoints have different params and schemas.
  • Some of the information served by the existing endpoints will be handled by the pipeline run feature.

This commit

  • Removes unused endpoints and updates metrics contracts to serve the new dashboard.

@jvallesm jvallesm self-assigned this Aug 22, 2024
Copy link

linear bot commented Aug 22, 2024

@jvallesm jvallesm changed the title y feat(mgmt): update metrics endpoints to serve new dashboard design Aug 22, 2024
@jvallesm jvallesm force-pushed the jvalles/ins-5379-credit-dashboard-endpoints branch from e4e7c4a to d1807cf Compare October 4, 2024 10:59
Copy link

github-actions bot commented Oct 4, 2024

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedOct 4, 2024, 10:59 AM

optional google.protobuf.Timestamp stop = 6;
}
// The ID of the namespace that requested the pipeline triggers.
string namespace_id = 3 [(google.api.field_behavior) = REQUIRED];
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this should be requester_id in order not to mix namespace (the owner of the pipeline triggers) with requester.

Also, is trigger the right term anymore or should we use run when documenting this fields?

cc @donch1989 @joremysh

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this should be requester_id in order not to mix namespace (the owner of the pipeline triggers) with requester.

It was agreed to use requester_id for this parameter 🤝

@@ -290,27 +290,13 @@ service MgmtPublicService {
rpc GetPipelineTriggerCount(GetPipelineTriggerCountRequest) returns (GetPipelineTriggerCountResponse) {
option (google.api.http) = {get: "/v1beta/metrics/vdp/pipeline/trigger-count"};
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the API discussion yesterday, this should look like

/pipeline-runs:count?requester_id=jvallesm&start=2024-10-15T00:00:00Z&stop=2024-10-16T00:00:00Z

// NOTE: This method will soon return the trigger counts of a given requester.
// Returns a timeline of pipline trigger counts for a given requester. The
// response will contain one set of records (datapoints), representing the
// amount of triggers in a time bucket.
rpc ListPipelineTriggerChartRecords(ListPipelineTriggerChartRecordsRequest) returns (ListPipelineTriggerChartRecordsResponse) {
option (google.api.http) = {get: "/v1beta/metrics/vdp/pipeline/charts"};
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the API discussion yesterday, this should look like

/pipeline-runs:query-charts?requester_id=jvallesm&start=...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: 🚧 Planned
Development

Successfully merging this pull request may close these issues.

2 participants